JBossAS - Server

Overview

Internal Name:	JBossAS Server
Description:	JBoss Application Server
Singleton:	no
Plugin:	JBossAS

Managed Resource Configuration

Binding to IP addresses

When starting JBossAS instances that need to be monitored using remote JMX (i.e. JNP), it is necessary for
the java.rmi.server.hostname System property to be set to the same value as the server's JNP
address (which is set to the jboss.bind.address System property by default). Due to bugs in JBossAS
(for more information please see JBAS-4736 and
JBAS-4955),
java.rmi.server.hostname will default to 127.0.0.1, unless JBossAS is started using
-b, in which case java.rmi.server.hostname will default to the bind address specified
as the argument to -b.

Therefore, you must start your JBossAS instances by using either -b:

run -b 12.34.56.78 ...

or by explicitly specifying a value for java.rmi.server.hostname via -D or
-P, e.g.:

run -Djboss.bind.address=12.34.56.78 -Djava.rmi.server.hostname=12.34.56.78 ...

Otherwise, you will not be able to manage the instance via JON.

Using -b is the recommended way to specify the bind address, since, in addition to setting
jboss.bind.address and java.rmi.server.hostname, it will also set other JGroups-related
System properties to the specified address.

Monitoring of EJB 2.x EJBs

The issue here is that JBossAS changed the way it creates the MBean names of the deployed EJBs from the
JNDI names / EJB names (this happened around version 4.0.3.sp1). Basically the <jndi-name>, or
<local-jndi-name> if <jndi-name> is not present, from jboss.xml is used.

So the workaround is to set the <jndi-name> to the ejb-name in your application.
As this probably breaks client code, you will want to setup a naming reference that restores the original
hierarchy. For example, if you have in jboss.xml:

&lt;session&gt;
&lt;ejb-name&gt;Ability&lt;/ejb-name&gt;
&lt;local-jndi-name&gt;flower.AbilityLocal&lt;/local-jndi-name&gt;

You might change this to:

&lt;session&gt;
&lt;ejb-name&gt;Ability&lt;/ejb-name&gt;
&lt;local-jndi-name&gt;Ability&lt;/local-jndi-name&gt;

And then add an MBean flowsys-naming-alias-service.xml:

&lt;mbean code=&quot;org.jboss.naming.NamingAlias&quot;
name=&quot;:service=naming-alias&quot;&gt;
&lt;attribute name=&quot;ToName&quot;&gt;flower.AbilityLocal&lt;/attribute&gt;
&lt;attribute name=&quot;FromName&quot;&gt;Ability&lt;/attribute&gt;
&lt;/mbean&gt;

After you have done this, go into the inventory of the respective beans, edit the
configuration and then click OK.

The naming alias ensures that clients of the Ability EJB can still find the bean in JNDI at the original
location. Naming aliases appear in JNDIView (within JMX-Console) as LinkRef.

Child Resource Types

Autodiscovery Process Scans

Name	Query
JBoss4	process\|basename\|match=^java.,arg\|org.jboss.Main\|match=.

Connection Settings

Name	Description	Required	Internal Name
Naming Provider URL	The JNP URL with which to connect to the JBoss Application Server instance (e.g. jnp://127.0.0.1:1099).	yes	namingURL
Principal	The name of the principal (i.e. user) to authenticate.	no	principal
Credentials	The credentials (i.e. password) that should be used to authenticate the principal.	no	credentials
JBoss Home Directory	The absolute path to the directory where JBossAS is installed (e.g. /opt/jboss-4.2.2.GA).	yes	jbossHomeDir
Configuration Path	The path to the configuration directory under which this instance operates (e.g. /opt/jboss-4.2.2.GA/server/default); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}.	yes	configurationPath
Configuration Set	The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {configurationPath}.	no	configurationSet
Script Prefix	A prefix applied to script execution commands; this prefix is applied verbatim. The full path of the executable is required (e.g. /usr/bin/sudo). For applicable platforms, this is typically a sudo command, so a sudo user must be configured appropriately for the specified command. Ignored if not set.	no	scriptPrefix
Start Script	The path to the script used by the 'Start' operation to start this JBossAS server (e.g. /opt/jboss-4.2.2.GA/bin/run.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/run.sh' on UNIX or 'bin\run.bat' on Windows.	no	startScript
Shutdown Script	The path to the script used by the 'Shutdown' operation to shutdown this JBossAS server (e.g. /opt/jboss-4.2.2.GA/bin/shutdown.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/shutdown.sh' on UNIX or 'bin\shutdown.bat' on Windows.	no	shutdownScript
Shutdown Method	The method used to execute the Shutdown operation; defaults to 'JMX MBean'.	no	shutdownMethod
Binding Address	The host or IP address used by all JBoss services as the binding address (e.g. 10.11.14.233); specify 0.0.0.0 to tell JBossAS to bind to all available network interfaces; defaults to '127.0.0.1'.	no	bindingAddress
JAVA_HOME Path	The absolute path to a JRE or JDK installation directory containing the JVM that should be used to start and shutdown the JBossAS instance; defaults to the home directory of the RHQ agent JRE.	no	javaHomePath
Start Wait Max	The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to start up. The default is 5 minutes.	no	startWaitMax
Stop Wait Max	The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to stop. The default is 2.5 minutes.	no	stopWaitMax
Log Event Sources		yes	logEventSources
Snapshot Config Enabled	If true, take a snapshot of the configuration	yes	snapshotConfigEnabled
Snapshot Config Directory	The directory containing the configuration files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path.	yes	snapshotConfigDirectory
Snapshot Config Regex	If defined, this regular expression must match a configuration file name if that file is to be captured in the snapshot. If not defined, all configuration files will be captured.	no	snapshotConfigRegex
Snapshot Config Recursive	If true, the snapshot will include files located in subdirectories under the config directory.	yes	snapshotConfigRecursive
Snapshot Log Enabled	If true, take a snapshot of the log files	yes	snapshotLogEnabled
Snapshot Log Directory	The directory containing the log files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path.	yes	snapshotLogDirectory
Snapshot Log Regex	If defined, this regular expression must match a log file name if that file is to be captured in the snapshot. If not defined, all log files will be captured.	no	snapshotLogRegex
Snapshot Log Recursive	If true, the snapshot will include files located in subdirectories under the log directory.	yes	snapshotLogRecursive
Snapshot Data Enabled	If true, take a snapshot of the data files	yes	snapshotDataEnabled
Snapshot Data Directory	The directory containing the data files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path.	yes	snapshotDataDirectory
Snapshot Data Regex	If defined, this regular expression must match a data file name if that file is to be captured in the snapshot. If not defined, all data files will be captured.	no	snapshotDataRegex
Snapshot Data Recursive	If true, the snapshot will include files located in subdirectories under the data directory.	yes	snapshotDataRecursive
Snapshot Additional Files List	Additional files to be included in the snapshot report	yes	snapshotAdditionalFilesList
Type	The type of the connection.	yes	type
Shutdown MBean Name	Name of the MBean to use when shutting down this server through JMX.	yes	shutdownMbeanName
Shutdown MBean Operation	Name of the operation to invoke when shutting down this server through JMX. Note that only operations with no parameter or with one int parameter are supported. If the operation requires an int parameter, '0' will be supplied.	yes	shutdownMbeanOperation
Availability Check Period	The amount of time, in seconds, that must elapse between availability checks to see if the server is up. If set, the availability checks will be performed asynchronously thus allowing slow-responding servers to avoid being falsely reported as down.	no	availabilityCheckPeriod
JBoss AS JVM Name	The name of the JBoss AS JVM resource.	no	childJmxServerName

You must use the internal name to reference properties in Dynamic Group Definition expressions.

Metrics

Name	Type	Description	Internal Name
Partition Name	trait	the name of the cluster partition this app server instance belongs to	partitionName
Version Name	trait	the code name for the this app server instance's major version (AS 3.2 = WonderLand, AS 4.0 = Zion, AS 4.2 = Trinity, EAP 4.x = EAP, SOA 4.x = SOA)	jboss.system:type=Server:VersionName
Build Date	trait	the date this app server was built	jboss.system:type=Server:BuildDate
Start Date	trait	the date and time this app server instance was started	jboss.system:type=Server:StartDate
Active Thread Count	measurement	The current number of active threads for this app server instance	jboss.system:type=ServerInfo:ActiveThreadCount
Active Thread Group Count	measurement	The current number of active thread groups for this app server instance	jboss.system:type=ServerInfo:ActiveThreadGroupCount
JVM Free Memory	measurement	An approximation of the total amount of memory currently available in the app server JVM for future allocated objects, measured in bytes	jboss.system:type=ServerInfo:FreeMemory
JVM Max Memory	measurement	The maximum amount of memory that the app server JVM will attempt to use, measured in bytes; if there is no inherent limit then the value Long.MAX_VALUE will be returned	jboss.system:type=ServerInfo:MaxMemory
JVM Total Memory	measurement	The total amount of memory currently available in the app server JVM for current and future objects, measured in bytes	jboss.system:type=ServerInfo:TotalMemory
Total Transactions	measurement	Total number of transactions since last restart	jboss:service=TransactionManager:TransactionCount
Total Transactions per Minute	measurement	Total number of transactions since last restart	jboss:service=TransactionManager:TransactionCount
Transactions Committed	measurement	Number of transactions commited since last restart	jboss:service=TransactionManager:CommitCount
Transactions Committed per Minute	measurement	Number of transactions commited since last restart	jboss:service=TransactionManager:CommitCount
Transactions Rolledback	measurement	Number of transactions commited since last restart	jboss:service=TransactionManager:RollbackCount
Transactions Rolledback per Minute	measurement	Number of transactions commited since last restart	jboss:service=TransactionManager:RollbackCount

You must use the internal name to reference traits in Dynamic Group Definition expressions.

Operations

Name	Description
Start	Start this application server. The script used is specified in the Operations group of connection properties.
Shutdown	Shutdown this application server via script or JMX depending on the settings in the Operations and Advanced groups of connection properties.
Restart	Shutdown and then start this application server.

Package Types

Name	Category	Description
Cumulative Patch	Deployable
Jar Library	Deployable

JBoss Community Archive (Read Only)

RHQ 4.5

JBossAS - Server

JBossAS - Server

Overview

Binding to IP addresses

Monitoring of EJB 2.x EJBs

Child Resource Types

Autodiscovery Process Scans

Connection Settings

Metrics

Operations

Package Types